Skip to content

Fix theme profile when running on Windows WSL #6830

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
EvilGenius13 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix theme profile when running on Windows WSL #6830

EvilGenius13 wants to merge 1 commit into from
+46 −4

Conversation

@EvilGenius13
Copy link
Contributor

@EvilGenius13 EvilGenius13 commented Feb 6, 2026 •
edited
Loading

WHY are these changes introduced?

Fixes #5414

Users running theme profile through Windows WSL (Windows Subsystem for Linux) would not have the final report pop up in their browser to view.

WHAT is this pull request doing?

  • Detect if the user is using WSL (we have an environment variable that is available when someone is using WSL)
  • Change the file path to match WSL pathing EX: (//wsl.Ubuntu)
  • The windows browser will pick up the path and open the profile file.

Couple Notes:

  1. There are two different versions of WSL - WSL1 and WSL2. This fix is agnostic
  2. There is a newer syntax using wsl.localhost which was made for WSL2 and then backported to WSL1. However, if you are locked to a certain version of windows, you may not have it so I chose not to use it.

How to test your changes?

You can ensure that theme profile still works by building the branch and running theme profile. If you want to tophat it on WSL, ping me and I can show you the options.

Post-release steps

Measuring impact

How do we know this change was effective? Please choose one:

  • n/a - this doesn't need measurement, e.g. a linting rule or a bug-fix
  • Existing analytics will cater for this addition
  • PR includes analytics changes to measure impact

Checklist

  • I've considered possible cross-platform impacts (Mac, Linux, Windows)
  • I've considered possible documentation changes

@EvilGenius13 EvilGenius13 force-pushed the wsl-theme-profile-fix branch from b821c13 to 60cea04 Compare February 6, 2026 15:42
@EvilGenius13
Copy link
Contributor Author

EvilGenius13 commented Feb 6, 2026

/snapit

@github-actions
Copy link
Contributor

github-actions bot commented Feb 6, 2026 •
edited
Loading

Coverage report

St.❔
 Category Percentage Covered / Total
🟡 Statements 79.63% 14477/18181
🟡 Branches 73.93% 7176/9706
🟡 Functions 79.78% 3689/4624
🟡 Lines 79.99% 13688/17113

Test suite run success

3720 tests passing in 1439 suites.

Report generated by 🧪jest coverage report action from a4b6164

@github-actions
Copy link
Contributor

github-actions bot commented Feb 6, 2026

🫰✨ Thanks @EvilGenius13! Your snapshot has been published to npm.

Test the snapshot by installing your package globally:

npm i -g --@shopify:registry=https://registry.npmjs.org @shopify/cli@0.0.0-snapshot-20260206155007

Caution

After installing, validate the version by running just shopify in your terminal.
If the versions don't match, you might have multiple global instances installed.
Use which shopify to find out which one you are running and uninstall it.

@EvilGenius13 EvilGenius13 force-pushed the wsl-theme-profile-fix branch 2 times, most recently from 1d63b39 to 63db1e3 Compare February 9, 2026 20:21
@github-actions
Copy link
Contributor

github-actions bot commented Feb 9, 2026

Differences in type declarations

We detected differences in the type declarations generated by Typescript for this branch compared to the baseline ('main' branch). Please, review them to ensure they are backward-compatible. Here are some important things to keep in mind:

  • Some seemingly private modules might be re-exported through public modules.
  • If the branch is behind main you might see odd diffs, rebase main into this branch.

New type declarations

We found no new type declarations in this PR

Existing type declarations

packages/cli-kit/dist/public/node/system.d.ts 
@@ -63,6 +63,16 @@ export declare function isCI(): boolean;
  * @returns True if the current environment is a WSL environment.
  */
 export declare function isWsl(): Promise<boolean>;
+/**
+ * Converts a Linux path to a Windows-accessible WSL path.
+ * Returns the Windows UNC path format (//wsl$/distro/path) if running in WSL,
+ * otherwise returns the original path unchanged.
+ * Works on both WSL1 and WSL2.
+ *
+ * @param linuxPath - The Linux filesystem path to convert.
+ * @returns Windows UNC path if in WSL, otherwise the original path.
+ */
+export declare function convertWslPath(linuxPath: string): string;
 /**
  * Check if stdin has piped data available.
  * This distinguishes between actual piped input (e.g., )

@EvilGenius13 EvilGenius13 force-pushed the wsl-theme-profile-fix branch 3 times, most recently from e725d97 to 6bc16fe Compare February 9, 2026 20:48
@EvilGenius13
Copy link
Contributor Author

EvilGenius13 commented Feb 9, 2026

/snapit

@github-actions
Copy link
Contributor

github-actions bot commented Feb 9, 2026

🫰✨ Thanks @EvilGenius13! Your snapshot has been published to npm.

Test the snapshot by installing your package globally:

npm i -g --@shopify:registry=https://registry.npmjs.org @shopify/cli@0.0.0-snapshot-20260209205123

Caution

After installing, validate the version by running just shopify in your terminal.
If the versions don't match, you might have multiple global instances installed.
Use which shopify to find out which one you are running and uninstall it.

@EvilGenius13 EvilGenius13 force-pushed the wsl-theme-profile-fix branch from 6bc16fe to e6acc27 Compare February 9, 2026 21:23
@EvilGenius13
Copy link
Contributor Author

EvilGenius13 commented Feb 9, 2026

/snapit

@github-actions
Copy link
Contributor

github-actions bot commented Feb 9, 2026

🫰✨ Thanks @EvilGenius13! Your snapshot has been published to npm.

Test the snapshot by installing your package globally:

npm i -g --@shopify:registry=https://registry.npmjs.org @shopify/cli@0.0.0-snapshot-20260209212442

Caution

After installing, validate the version by running just shopify in your terminal.
If the versions don't match, you might have multiple global instances installed.
Use which shopify to find out which one you are running and uninstall it.

@EvilGenius13 EvilGenius13 force-pushed the wsl-theme-profile-fix branch 2 times, most recently from 3cdfd85 to b4d96e6 Compare February 9, 2026 22:13
@EvilGenius13 EvilGenius13 changed the title wip Fix theme profile when running on Windows WSL Feb 10, 2026
@EvilGenius13 EvilGenius13 marked this pull request as ready for review February 10, 2026 18:38
@EvilGenius13 EvilGenius13 requested review from a team as code owners February 10, 2026 18:38
@github-actions
Copy link
Contributor

github-actions bot commented Feb 10, 2026

We detected some changes at packages/*/src and there are no updates in the .changeset.
If the changes are user-facing, run pnpm changeset add to track your changes and include them in the next release CHANGELOG.

Caution

DO NOT create changesets for features which you do not wish to be included in the public changelog of the next CLI release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[Bug]: profile command not working on Windows on WSL

1 participant

@EvilGenius13